HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia
​0.1.0 - Zambia flag

HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ZM-Core Recipient Group Profile

Official URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-group Version: 0.1.0
Active as of 2026-08-12 Computable Name: ZMCoreGroup

A governed national, provincial, district, facility, patient, or workforce distribution group used for recipient resolution.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and their representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group 0..* Group Group of multiple entities
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... active ?!SΣ 1..1 boolean Whether this group's record is in active use
... type SΣ 1..1 code person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
Binding: GroupType (required): Types of resources that are part of group.
... membership SΣ 1..1 code definitional | enumerated
Binding: GroupMembershipBasis (required): The basis for membership in a group
... code SΣ 1..1 CodeableConcept Kind of Group members
Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc.
... name SΣ 1..1 string Label for Group
... description S 0..1 markdown Natural language description of the group
... managingEntity SΣ 1..1 Reference(ZM-Core Organization Profile | ZM-Core Practitioner Role Profile) Entity that is the custodian of the Group's definition
... characteristic SΣ 0..* BackboneElement Include / Exclude group members by Trait
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
.... value[x] Σ 1..1 Value held by characteristic
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
..... valueCodeableConcept CodeableConcept
..... valueBoolean boolean
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(Any)
.... exclude Σ 1..1 boolean Group includes or excludes
... member S 0..* BackboneElement Who or what is in group
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity S 1..1 Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen) Reference to the group member
.... period S 0..1 Period Period member belonged to the group
.... inactive S 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.type Base required Group Type 📍5.0.0 FHIR Std.
Group.membership Base required Group Membership Basis 📍5.0.0 FHIR Std.
Group.code Base example Not State Unknown
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group 0..* Group Group of multiple entities
... identifier S 1..* Identifier Business Identifier for this Group
... active S 1..1 boolean Whether this group's record is in active use
... type S 1..1 code person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
... code S 1..1 CodeableConcept Kind of Group members
... name S 1..1 string Label for Group
... description S 0..1 markdown Natural language description of the group
... managingEntity S 1..1 Reference(ZM-Core Organization Profile | ZM-Core Practitioner Role Profile) Entity that is the custodian of the Group's definition
... characteristic S 0..* BackboneElement Include / Exclude group members by Trait
... member S 0..* BackboneElement Who or what is in group
.... entity S 1..1 Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen) Reference to the group member
.... period S 0..1 Period Period member belonged to the group
.... inactive S 0..1 boolean If member is no longer in group

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group 0..* Group Group of multiple entities
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier Business Identifier for this Group
... active ?!SΣ 1..1 boolean Whether this group's record is in active use
... type SΣ 1..1 code person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
Binding: GroupType (required): Types of resources that are part of group.
... membership SΣ 1..1 code definitional | enumerated
Binding: GroupMembershipBasis (required): The basis for membership in a group
... code SΣ 1..1 CodeableConcept Kind of Group members
Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc.
... name SΣ 1..1 string Label for Group
... description S 0..1 markdown Natural language description of the group
... quantity Σ 0..1 unsignedInt Number of members
... managingEntity SΣ 1..1 Reference(ZM-Core Organization Profile | ZM-Core Practitioner Role Profile) Entity that is the custodian of the Group's definition
... characteristic SΣ 0..* BackboneElement Include / Exclude group members by Trait
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
.... value[x] Σ 1..1 Value held by characteristic
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
..... valueCodeableConcept CodeableConcept
..... valueBoolean boolean
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(Any)
.... exclude Σ 1..1 boolean Group includes or excludes
.... period 0..1 Period Period over which characteristic is tested
... member S 0..* BackboneElement Who or what is in group
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity S 1..1 Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen) Reference to the group member
.... period S 0..1 Period Period member belonged to the group
.... inactive S 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.language Base required All Languages 📍5.0.0 FHIR Std.
Group.type Base required Group Type 📍5.0.0 FHIR Std.
Group.membership Base required Group Membership Basis 📍5.0.0 FHIR Std.
Group.code Base example Not State Unknown
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group 0..* Group Group of multiple entities
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... active ?!SΣ 1..1 boolean Whether this group's record is in active use
... type SΣ 1..1 code person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
Binding: GroupType (required): Types of resources that are part of group.
... membership SΣ 1..1 code definitional | enumerated
Binding: GroupMembershipBasis (required): The basis for membership in a group
... code SΣ 1..1 CodeableConcept Kind of Group members
Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc.
... name SΣ 1..1 string Label for Group
... description S 0..1 markdown Natural language description of the group
... managingEntity SΣ 1..1 Reference(ZM-Core Organization Profile | ZM-Core Practitioner Role Profile) Entity that is the custodian of the Group's definition
... characteristic SΣ 0..* BackboneElement Include / Exclude group members by Trait
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
.... value[x] Σ 1..1 Value held by characteristic
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
..... valueCodeableConcept CodeableConcept
..... valueBoolean boolean
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(Any)
.... exclude Σ 1..1 boolean Group includes or excludes
... member S 0..* BackboneElement Who or what is in group
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity S 1..1 Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen) Reference to the group member
.... period S 0..1 Period Period member belonged to the group
.... inactive S 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.type Base required Group Type 📍5.0.0 FHIR Std.
Group.membership Base required Group Membership Basis 📍5.0.0 FHIR Std.
Group.code Base example Not State Unknown
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group 0..* Group Group of multiple entities
... identifier S 1..* Identifier Business Identifier for this Group
... active S 1..1 boolean Whether this group's record is in active use
... type S 1..1 code person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
... code S 1..1 CodeableConcept Kind of Group members
... name S 1..1 string Label for Group
... description S 0..1 markdown Natural language description of the group
... managingEntity S 1..1 Reference(ZM-Core Organization Profile | ZM-Core Practitioner Role Profile) Entity that is the custodian of the Group's definition
... characteristic S 0..* BackboneElement Include / Exclude group members by Trait
... member S 0..* BackboneElement Who or what is in group
.... entity S 1..1 Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen) Reference to the group member
.... period S 0..1 Period Period member belonged to the group
.... inactive S 0..1 boolean If member is no longer in group

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group 0..* Group Group of multiple entities
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier Business Identifier for this Group
... active ?!SΣ 1..1 boolean Whether this group's record is in active use
... type SΣ 1..1 code person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
Binding: GroupType (required): Types of resources that are part of group.
... membership SΣ 1..1 code definitional | enumerated
Binding: GroupMembershipBasis (required): The basis for membership in a group
... code SΣ 1..1 CodeableConcept Kind of Group members
Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc.
... name SΣ 1..1 string Label for Group
... description S 0..1 markdown Natural language description of the group
... quantity Σ 0..1 unsignedInt Number of members
... managingEntity SΣ 1..1 Reference(ZM-Core Organization Profile | ZM-Core Practitioner Role Profile) Entity that is the custodian of the Group's definition
... characteristic SΣ 0..* BackboneElement Include / Exclude group members by Trait
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
.... value[x] Σ 1..1 Value held by characteristic
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
..... valueCodeableConcept CodeableConcept
..... valueBoolean boolean
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(Any)
.... exclude Σ 1..1 boolean Group includes or excludes
.... period 0..1 Period Period over which characteristic is tested
... member S 0..* BackboneElement Who or what is in group
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity S 1..1 Reference(CareTeam | Device | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Specimen) Reference to the group member
.... period S 0..1 Period Period member belonged to the group
.... inactive S 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.language Base required All Languages 📍5.0.0 FHIR Std.
Group.type Base required Group Type 📍5.0.0 FHIR Std.
Group.membership Base required Group Membership Basis 📍5.0.0 FHIR Std.
Group.code Base example Not State Unknown
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Group If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron